﻿====================================================================
            README FILE FOR POKÉMON MYSTERY GIFT EDITOR
                version 1.4 bèta 3 - March 9, 2010
====================================================================

-----------------------------
  Table of Contents
-----------------------------
1. General Information
2. Changelog
3. Requirements
4. How To Use
5. Research and Development
6. Thanks
7. Contact


-----------------------------
  1. General Information
-----------------------------
Please view this Readme without word wrap enabled.

This program is created by Grovyle91 and is intended to be used with
Pokémon Diamond, Pearl, Platinum, HeartGold and SoulSilver save
files.
You are able to edit the mystery gifts, import and export Gifts
(PGT files) and Wonder Cards (PCD) and there's also some basic
editing available.


-----------------------------
  2. Changelog
-----------------------------
v1.4 bèta 3 (March 9, 2010)
  - Fixed an "index out of range" error that occoured when editing
    something in the MG related editor in a D/P save
  - Fixed a problem when dropping a save file on the executable

v1.4 bèta 2 (February 14, 2010)
  - Fixed the corrupted PNG export in the WC Previewer which
    occurred on some computers
  - The textboxes Card Title/Comment are wider now so that
    everything in it is visible now
  - Some other controls are wider now as well to compensate the old
    Win98 look
  - Fixed Korean character mapping in the WC Previewer
  - Fixed Pokémon icon positions in the WC Previewer

v1.4 bèta (February 6, 2010)
  - Added experimental Action Replay DS Code export support
  - Changed the Pokemon fonts to kazumi's
  - Wonder Cards should now be exactly the same as in-game (thanks
    to kazumi)
  - Added the feature to create a Gift from a Wonder Card
  - Added Korean and Dutch (unofficial) language support for the
    Wonder Card Previewer
  - Added keyboard shortcuts for the Wonder Card Previewer
  - You can now drop PGT and PCD files on the window as well, the
    program will ask if you want to overwrite the current Gift/WC
  - Changed the numeric controls to dropdown boxes where you can
    select the current Gift and/or Wonder Card
  - Raised the maximum value of the Wonder Card IDs up to 2046
    since this is supported in the save file
  - Moved the character table inside the code
  - Changed some HGSS exclusive items to their English equalivants,
    according to Serebii.net
  - Fixed a bug that prevented the checkbox for active Gift/WC in DP
    save files from working correctly

v1.3 (January 21, 2010)
  - Code optimization for easier implementation of more save file
    editing
  - Added 256 KB save file support
  - Added more Mystery Gift related editing functions (Mystery Gift
    enabling, used Wonder Card IDs)
  - Added some more Pokémon editing functions
  - Added the Symbol Inserter
  - Added the Wonder Card Previewer (Japanese not fully supported,
    Korean not implemented yet)
  - Fixed bug that will prevent the program loading a Wonder Card
    when its distribution amount is unlimited
  - More detailed error messages
    - File mismatch: files which aren't Pokémon save files will now
      throw this exception
    - File size mismatch: files which doesn't equals its correct
      size won't be loaded/imported anymore (which was still
      possible at certain circumstances)
    - Unknown error messages will have a trace from now on, this
      will help me to find the bug easier when reported (just
      CTRL+C the window to copy the text)

v1.2c (January 12, 2010)
  - Fixed bug that prevents the program from determining the active
    block in Pt/HG/SS

v1.2b (January 11, 2010)
  - Fixed bug that was causing the wrong block shuffling with
    certain Pokémon when importing unencrypted PKM files
  - The forgotten Gift PKM import is now also allowed to import
    unencrypted PKM files

v1.2a (January 11, 2010)
  - Fixed the "not saving" bug when there's already a backup file
  - Fixed the messages which appear when switching to a Pokémon
    Gift Type without actually a Pokémon imported
  - Fixed the icon in the window in the Windows 7 taskbar
  - The button to change the edit mode is disabled now after
    dropping a save file on the window

v1.2 (January 10, 2010)
  - Added unencrypted PKM file support
  - Added first PKM editing basics (read-only: editing is not
    possible yet)
  - Added Pokémon icons
  - Program is asking now to save the changes when saving the save
    file if it hasn't been saved already

v1.1 (January 6, 2010)
  - Internal code optimization
  - Added the possibility to edit a PGT or PCD file only (without
    loading a save file first)
  - Switching between the PGTs or PCDs will not longer revert the
    changes if they were not saved
  - Added the option to disable the automatic save file backup
  - Fixed Card Value byte (was not updating when the Gift Type
    was changed)
  - User settings are now saved in a *.ini file, instead of a big
    XML file
  - Uses now the game icon(s), instead of text for showing which
    game the save file is from
  - Program icon changed

v1.0 (January 4, 2010)
  - Initial release


-----------------------------
  3. Requirements
-----------------------------
In order to run this program, .NET Framework 2.0 or higher must be
installed on the machine.


-----------------------------
  4. How To Use
-----------------------------
To load a save file, you can not only use the Open button, but you
can also drop a file on the executable or program window.
It will automatically detect if it's a D/P, Pt or HGSS save.
Depending on the game, there will be more or less options
available for you to edit.
To edit a PGT or PCD file only, please click on the button on the
top right of the main window to activate the "Edit mode".

This program is able to import and export PGT and PCD files and you
can edit the values where needed.
It is safe to use any character from a foreign language, as long as
it's supported by the game, in other words, if it's exist in the
character table. If it doesn't, the program will prevent from adding
it.

When you've edited a Gift or Wonder Card, the button to save will
automatically appear, there will also be a reset button for
resetting the whole Gift or Wonder Card. If something hasn't been
saved when saving the save file, the program will ask you if you
want to save the changes.

If an error pops up, please check which error it is before reporting
it on the forum. If an error has something to do with a file, please
check first whether this file is valid or not. If it is, please do
report the error! I can use all help to make this program better!

Since version 1.3 the program has some new functions, such as the
Symbol Inserter and Wonder Card Previewer. With the Symbol Inserter
you can insert any character that exists in the character table and
with the Wonder Card Previewer you can view the Wonder Card just as
the game does. You're able to right click on the Wonder Card to get
more functions.
Since version 1.4 Action Replay export is supported. Although this
is just experimental for now, it should work in the most cases.

If you don't like the background or if you're not able to read the
text, you can disable this in the settings. This also applies to
slow computers, because rendering the background requires a modern
computer (2.0 GHz dual-core or higher).


-----------------------------
  5. Research and Development
-----------------------------
 - There will be a PKM editor when I've enough spare time.
 - If someone knows more Gift Types, please share them with me so I
   can import it in this program.
     0x00:   (none)
     0x01:   Pokémon
     0x02:   Pokémon Egg
     0x03:   Item
     0x04:   Rule
     0x05:   Seal
     0x06:   Accessory
     0x07:   Manaphy Egg
     0x08:   Member Card
     0x09:   Oak's Letter
     0x0A:   Azure Flute
     0x0B:   Pokétch App
     0x0C:   Secret Key
     0x0D:   (unknown)
     0x0E:   Pokéwalker Area
     >=0x0F: (unknown)
 - Please also share the Pokéwalker Areas, I might import them in a
   later version.
 - I need someone who can extract and build lists of the Seals,
   Accessories, Pokétch Apps and Pokéwalker Areas. Or someone who
   has it already.

-----------------------------
  6. Thanks
-----------------------------
Without the research of these people, I could possibly not make
this program, so thank you all!

 - Jiggy-Ninja, codemonkey85 and mostly kazumi213 who created the
   character table.
 - Sabresite for writing the C# algorithm of the checksum of the
   save file on the wiki.
 - kazumi213 for the Pokemon DPPt TTF, Poryhack for pointing to it.
 - kazumi213 for the various sheets of the Pokemon fonts which
   helped me creating Wonder Card previews that look exactly as the
   cards in-game.
 - codemonkey85 for various suggestions and helping me out in some
   ways.
 - Bulbapedia for the lists.

I'll also thank the developers of PPSE, without the source being
online, it would've costed me much more time to figure out the
encryption and decryption of the PKM files.

And of course I'll thank projectpokemon.org for being such a great
site and everyone who uses this program!


-----------------------------
  7. Contact
-----------------------------
If you want to report a bug, request a feature or something else
with this program, you can contact me at projectpokemon.org forums
under the name Grovyle91, or go directly to the thread:
http://www.projectpokemon.org/forums/showthread.php?t=6524